<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>simMsgBox</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>

<body>

<div align="center">
<table class=allEncompassingTable >
 <tr>
  <td >
<p><a href="../../index.html" TARGET="_top"><img src="../images/homeImg.png"></a></p>

<h1>Regular API function</h1>
<h3 class=subsectionBar><a name="simMsgBox" id="simMsgBox"></a>simMsgBox / sim.msgBox </h3>
<table class=apiTable>
<tr class=apiTableTr> 
<td class=apiTableLeftDescr>
Description 
</td> 
<td class=apiTableRightDescr>Opens a modal message box for interaction with the user.  See also <a href="simFileDialog.htm">sim.fileDialog</a> and <a href="simDisplayDialog.htm">sim.displayDialog</a><br></td>
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCSyn>
C synopsis
</td> 
<td class=apiTableRightCSyn>simInt simMsgBox(simInt dlgType,simInt buttons,const simChar* title,const simChar* message)<br></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCParam>C parameters</td> 
<td class=apiTableRightCParam>
<div><strong>dlgType</strong>: the <a href="../apiConstants.htm#msgBoxTypes">message box type</a>.</div>
<div><strong>buttons</strong>: the <a href="../apiConstants.htm#msgBoxButtons">buttons to display</a>.</div>
<div><strong>title</strong>: title of the dialog</div>
<div><strong>message</strong>: the message to display</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCRet>
C return value
</td> 
<td class=apiTableRightCRet>
<div>a <a href="../apiConstants.htm#msgBoxReturn">message box return value</a>. When the &lt;esc&gt; key, or the dialog close button was pressed, then the return value is:</div>
<div class=tab>yes/no dialog: sim.msgbox_return_no</div>
<div class=tab>ok dialog: sim.msgbox_return_ok</div>
<div class=tab>ok/cancel dialog: sim.msgbox_return_cancel</div>
<div class=tab>yes/no/cancel dialog: sim.msgbox_return_cancel</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLSyn>
Lua synopsis
</td> 
<td class=apiTableRightLSyn>int returnValue=sim.msgBox(int dlgType,int buttons,string title,string message)<br></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLParam>Lua parameters</td> 
<td class=apiTableRightLParam>
<div>Similar to the C-function counterpart</div>
<div></div></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLRet>
Lua return values
</td> 
<td class=apiTableRightLRet>
<div>Similar to the C-function counterpart</div>
<div></div></td> 
</tr> 
</table> 


<br>
</td>
</tr>
</table>
</div>
</body>
</html>
